<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.typehandlers.base.BuildValueParameters</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        <a href="pybindgen.typehandlers-module.html">Package&nbsp;typehandlers</a> ::
        <a href="pybindgen.typehandlers.base-module.html">Module&nbsp;base</a> ::
        Class&nbsp;BuildValueParameters
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.typehandlers.base.BuildValueParameters-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BuildValueParameters</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_pybindge_70" name="uml_class_diagram_for_pybindge_70">
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#__init__" title="pybindgen.typehandlers.base.BuildValueParameters.__init__" alt="" coords="17,36,561,55"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#clear" title="pybindgen.typehandlers.base.BuildValueParameters.clear" alt="" coords="17,55,561,73"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#add_parameter" title="Adds a new parameter to the Py_BuildValue (or similar) statement." alt="" coords="17,73,561,92"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#get_parameters" title="returns a list of parameters to pass into a Py_BuildValue&#45;style function &#160;call, the first paramter in the list being the template string." alt="" coords="17,92,561,111"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#get_cleanups" title="Get a list of handles to cleanup actions" alt="" coords="17,111,561,129"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html" title="Object to keep track of Py_BuildValue (or similar) parameters" alt="" coords="16,11,563,131"/>
</map>
  <img src="uml_class_diagram_for_pybindge_70.gif" alt='' usemap="#uml_class_diagram_for_pybindge_70" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Object to keep track of Py_BuildValue (or similar) parameters</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.typehandlers.base.BuildValueParameters-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.__init__">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___53-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for___init___53-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___53" name="call_graph_for___init___53">
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#__init__" title="__init__()" alt="" coords="367,33,471,65"/>
<area shape="rect" href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html#__init__" title="ForwardWrapperBase.__init__()" alt="" coords="7,5,316,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html#__init__" title="ReverseWrapperBase.__init__()" alt="" coords="8,61,315,93"/>
</map>
  <img src="call_graph_for___init___53.gif" alt='' usemap="#call_graph_for___init___53" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="clear"></a><span class="summary-sig-name">clear</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.clear">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_clear-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_clear-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_clear" name="call_graph_for_clear">
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#clear" title="clear()" alt="" coords="560,33,640,65"/>
<area shape="rect" href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html#reset_code_generation_state" title="ForwardWrapperBase.reset_code_generation_state()" alt="" coords="5,5,512,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html#reset_code_generation_state" title="ReverseWrapperBase.reset_code_generation_state()" alt="" coords="7,61,511,93"/>
</map>
  <img src="call_graph_for_clear.gif" alt='' usemap="#call_graph_for_clear" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.typehandlers.base.BuildValueParameters-class.html#add_parameter" class="summary-sig-name">add_parameter</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">param_template</span>,
        <span class="summary-sig-arg">param_values</span>,
        <span class="summary-sig-arg">prepend</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">cancels_cleanup</span>=<span class="summary-sig-default">None</span>)</span><br />
      Adds a new parameter to the Py_BuildValue (or similar) statement.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.add_parameter">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_add_parameter-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_add_parameter-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_add_parameter" name="call_graph_for_add_parameter">
<area shape="rect" href="pybindgen.container.ContainerParameter-class.html#convert_c_to_python" title="container.ContainerParameter.convert_c_to_python()" alt="" coords="85,21,595,53"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#add_parameter" title="add_parameter()" alt="" coords="724,749,897,781"/>
<area shape="rect" href="pybindgen.container.ContainerPtrParameter-class.html#convert_python_to_c" title="container.ContainerPtrParameter.convert_python_to_c()" alt="" coords="71,77,609,109"/>
<area shape="rect" href="pybindgen.container.ContainerRefParameter-class.html#convert_c_to_python" title="container.ContainerRefParameter.convert_c_to_python()" alt="" coords="71,133,609,165"/>
<area shape="rect" href="pybindgen.container.ContainerRefParameter-class.html#convert_python_to_c" title="container.ContainerRefParameter.convert_python_to_c()" alt="" coords="71,189,609,221"/>
<area shape="rect" href="pybindgen.container.ContainerReturnValue-class.html#convert_c_to_python" title="container.ContainerReturnValue.convert_c_to_python()" alt="" coords="75,245,605,277"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassParameter.convert_c_to_python()" alt="" coords="31,301,649,333"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassPtrParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassPtrParameter.convert_c_to_python()" alt="" coords="16,357,664,389"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassPtrReturnValue-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassPtrReturnValue.convert_c_to_python()" alt="" coords="7,413,673,445"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassRefParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassRefParameter.convert_c_to_python()" alt="" coords="16,469,664,501"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassRefParameter-class.html#convert_python_to_c" title="cppclass_typehandlers.CppClassRefParameter.convert_python_to_c()" alt="" coords="16,525,664,557"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassReturnValue-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassReturnValue.convert_c_to_python()" alt="" coords="20,581,660,613"/>
<area shape="rect" href="pybindgen.typehandlers.booltype.BoolReturn-class.html#convert_c_to_python" title="booltype.BoolReturn.convert_c_to_python()" alt="" coords="129,637,551,669"/>
<area shape="rect" href="pybindgen.typehandlers.doubletype.DoubleReturn-class.html#convert_c_to_python" title="doubletype.DoubleReturn.convert_c_to_python()" alt="" coords="105,693,575,725"/>
<area shape="rect" href="pybindgen.typehandlers.floattype.FloatPtrParam-class.html#convert_python_to_c" title="floattype.FloatPtrParam.convert_python_to_c()" alt="" coords="112,749,568,781"/>
<area shape="rect" href="pybindgen.typehandlers.floattype.FloatReturn-class.html#convert_c_to_python" title="floattype.FloatReturn.convert_c_to_python()" alt="" coords="124,805,556,837"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntParam-class.html#convert_c_to_python" title="inttype.IntParam.convert_c_to_python()" alt="" coords="145,861,535,893"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntRefParam-class.html#convert_python_to_c" title="inttype.IntRefParam.convert_python_to_c()" alt="" coords="131,917,549,949"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntReturn-class.html#convert_c_to_python" title="inttype.IntReturn.convert_c_to_python()" alt="" coords="143,973,537,1005"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.SizeTReturn-class.html#convert_c_to_python" title="inttype.SizeTReturn.convert_c_to_python()" alt="" coords="131,1029,549,1061"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UInt16Return-class.html#convert_c_to_python" title="inttype.UInt16Return.convert_c_to_python()" alt="" coords="124,1085,556,1117"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UInt8Return-class.html#convert_c_to_python" title="inttype.UInt8Return.convert_c_to_python()" alt="" coords="129,1141,551,1173"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UnsignedIntReturn-class.html#convert_c_to_python" title="inttype.UnsignedIntReturn.convert_c_to_python()" alt="" coords="100,1197,580,1229"/>
<area shape="rect" href="pybindgen.typehandlers.pyobjecttype.PyObjectParam-class.html#convert_c_to_python" title="pyobjecttype.PyObjectParam.convert_c_to_python()" alt="" coords="91,1253,589,1285"/>
<area shape="rect" href="pybindgen.typehandlers.pyobjecttype.PyObjectReturnValue-class.html#convert_c_to_python" title="pyobjecttype.PyObjectReturnValue.convert_c_to_python()" alt="" coords="63,1309,617,1341"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.CStringReturn-class.html#convert_c_to_python" title="stringtype.CStringReturn.convert_c_to_python()" alt="" coords="107,1365,573,1397"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.StdStringRefParam-class.html#convert_python_to_c" title="stringtype.StdStringRefParam.convert_python_to_c()" alt="" coords="87,1421,593,1453"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.StdStringReturn-class.html#convert_c_to_python" title="stringtype.StdStringReturn.convert_c_to_python()" alt="" coords="99,1477,581,1509"/>
</map>
  <img src="call_graph_for_add_parameter.gif" alt='' usemap="#call_graph_for_add_parameter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.typehandlers.base.BuildValueParameters-class.html#get_parameters" class="summary-sig-name">get_parameters</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">force_tuple_creation</span>=<span class="summary-sig-default">False</span>)</span><br />
      returns a list of parameters to pass into a Py_BuildValue-style 
      function call, the first paramter in the list being the template 
      string.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.get_parameters">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_parameters-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_get_parameters-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_parameters" name="call_graph_for_get_parameters">
<area shape="rect" href="pybindgen.converter_functions.CToPythonConverter-class.html#generate" title="converter_functions.CToPythonConverter.generate()" alt="" coords="35,5,539,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#get_parameters" title="get_parameters()" alt="" coords="617,61,796,93"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodProxy-class.html#generate_python_call" title="cppmethod.CppVirtualMethodProxy.generate_python_call()" alt="" coords="7,61,567,93"/>
<area shape="rect" href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html#generate_body" title="ForwardWrapperBase.generate_body()" alt="" coords="99,117,475,149"/>
</map>
  <img src="call_graph_for_get_parameters.gif" alt='' usemap="#call_graph_for_get_parameters" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_cleanups"></a><span class="summary-sig-name">get_cleanups</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Get a list of handles to cleanup actions</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.get_cleanups">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.__init__">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___53-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for___init___53-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___53" name="call_graph_for___init___53">
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#__init__" title="__init__()" alt="" coords="367,33,471,65"/>
<area shape="rect" href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html#__init__" title="ForwardWrapperBase.__init__()" alt="" coords="7,5,316,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReverseWrapperBase-class.html#__init__" title="ReverseWrapperBase.__init__()" alt="" coords="8,61,315,93"/>
</map>
  <img src="call_graph_for___init___53.gif" alt='' usemap="#call_graph_for___init___53" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>bld = BuildValueParameters()
<span class="py-prompt">&gt;&gt;&gt; </span>bld.add_parameter(<span class="py-string">'i'</span>, [123, 456])
<span class="py-prompt">&gt;&gt;&gt; </span>bld.add_parameter(<span class="py-string">'s'</span>, [<span class="py-string">&quot;hello&quot;</span>])
<span class="py-prompt">&gt;&gt;&gt; </span>bld.get_parameters()
<span class="py-output">['&quot;is&quot;', 123, 456, 'hello']</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>bld = BuildValueParameters()
<span class="py-prompt">&gt;&gt;&gt; </span>bld.add_parameter(<span class="py-string">'i'</span>, [123])
<span class="py-prompt">&gt;&gt;&gt; </span>bld.add_parameter(<span class="py-string">'s'</span>, [<span class="py-string">&quot;hello&quot;</span>], prepend=True)
<span class="py-prompt">&gt;&gt;&gt; </span>bld.get_parameters()
<span class="py-output">['&quot;si&quot;', 'hello', 123]</span></pre>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_parameter"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_parameter</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">param_template</span>,
        <span class="sig-arg">param_values</span>,
        <span class="sig-arg">prepend</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">cancels_cleanup</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.add_parameter">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_add_parameter-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_add_parameter-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_add_parameter" name="call_graph_for_add_parameter">
<area shape="rect" href="pybindgen.container.ContainerParameter-class.html#convert_c_to_python" title="container.ContainerParameter.convert_c_to_python()" alt="" coords="85,21,595,53"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#add_parameter" title="add_parameter()" alt="" coords="724,749,897,781"/>
<area shape="rect" href="pybindgen.container.ContainerPtrParameter-class.html#convert_python_to_c" title="container.ContainerPtrParameter.convert_python_to_c()" alt="" coords="71,77,609,109"/>
<area shape="rect" href="pybindgen.container.ContainerRefParameter-class.html#convert_c_to_python" title="container.ContainerRefParameter.convert_c_to_python()" alt="" coords="71,133,609,165"/>
<area shape="rect" href="pybindgen.container.ContainerRefParameter-class.html#convert_python_to_c" title="container.ContainerRefParameter.convert_python_to_c()" alt="" coords="71,189,609,221"/>
<area shape="rect" href="pybindgen.container.ContainerReturnValue-class.html#convert_c_to_python" title="container.ContainerReturnValue.convert_c_to_python()" alt="" coords="75,245,605,277"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassParameter.convert_c_to_python()" alt="" coords="31,301,649,333"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassPtrParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassPtrParameter.convert_c_to_python()" alt="" coords="16,357,664,389"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassPtrReturnValue-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassPtrReturnValue.convert_c_to_python()" alt="" coords="7,413,673,445"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassRefParameter-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassRefParameter.convert_c_to_python()" alt="" coords="16,469,664,501"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassRefParameter-class.html#convert_python_to_c" title="cppclass_typehandlers.CppClassRefParameter.convert_python_to_c()" alt="" coords="16,525,664,557"/>
<area shape="rect" href="pybindgen.cppclass_typehandlers.CppClassReturnValue-class.html#convert_c_to_python" title="cppclass_typehandlers.CppClassReturnValue.convert_c_to_python()" alt="" coords="20,581,660,613"/>
<area shape="rect" href="pybindgen.typehandlers.booltype.BoolReturn-class.html#convert_c_to_python" title="booltype.BoolReturn.convert_c_to_python()" alt="" coords="129,637,551,669"/>
<area shape="rect" href="pybindgen.typehandlers.doubletype.DoubleReturn-class.html#convert_c_to_python" title="doubletype.DoubleReturn.convert_c_to_python()" alt="" coords="105,693,575,725"/>
<area shape="rect" href="pybindgen.typehandlers.floattype.FloatPtrParam-class.html#convert_python_to_c" title="floattype.FloatPtrParam.convert_python_to_c()" alt="" coords="112,749,568,781"/>
<area shape="rect" href="pybindgen.typehandlers.floattype.FloatReturn-class.html#convert_c_to_python" title="floattype.FloatReturn.convert_c_to_python()" alt="" coords="124,805,556,837"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntParam-class.html#convert_c_to_python" title="inttype.IntParam.convert_c_to_python()" alt="" coords="145,861,535,893"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntRefParam-class.html#convert_python_to_c" title="inttype.IntRefParam.convert_python_to_c()" alt="" coords="131,917,549,949"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.IntReturn-class.html#convert_c_to_python" title="inttype.IntReturn.convert_c_to_python()" alt="" coords="143,973,537,1005"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.SizeTReturn-class.html#convert_c_to_python" title="inttype.SizeTReturn.convert_c_to_python()" alt="" coords="131,1029,549,1061"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UInt16Return-class.html#convert_c_to_python" title="inttype.UInt16Return.convert_c_to_python()" alt="" coords="124,1085,556,1117"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UInt8Return-class.html#convert_c_to_python" title="inttype.UInt8Return.convert_c_to_python()" alt="" coords="129,1141,551,1173"/>
<area shape="rect" href="pybindgen.typehandlers.inttype.UnsignedIntReturn-class.html#convert_c_to_python" title="inttype.UnsignedIntReturn.convert_c_to_python()" alt="" coords="100,1197,580,1229"/>
<area shape="rect" href="pybindgen.typehandlers.pyobjecttype.PyObjectParam-class.html#convert_c_to_python" title="pyobjecttype.PyObjectParam.convert_c_to_python()" alt="" coords="91,1253,589,1285"/>
<area shape="rect" href="pybindgen.typehandlers.pyobjecttype.PyObjectReturnValue-class.html#convert_c_to_python" title="pyobjecttype.PyObjectReturnValue.convert_c_to_python()" alt="" coords="63,1309,617,1341"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.CStringReturn-class.html#convert_c_to_python" title="stringtype.CStringReturn.convert_c_to_python()" alt="" coords="107,1365,573,1397"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.StdStringRefParam-class.html#convert_python_to_c" title="stringtype.StdStringRefParam.convert_python_to_c()" alt="" coords="87,1421,593,1453"/>
<area shape="rect" href="pybindgen.typehandlers.stringtype.StdStringReturn-class.html#convert_c_to_python" title="stringtype.StdStringReturn.convert_c_to_python()" alt="" coords="99,1477,581,1509"/>
</map>
  <img src="call_graph_for_add_parameter.gif" alt='' usemap="#call_graph_for_add_parameter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Adds a new parameter to the Py_BuildValue (or similar) statement.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>param_template</code></strong> - template item, see documentation for Py_BuildValue for more 
          information</li>
        <li><strong class="pname"><code>param_values</code></strong> - list of C expressions to use as value, see documentation for 
          Py_BuildValue for more information</li>
        <li><strong class="pname"><code>prepend</code></strong> - whether this parameter should come first in the tuple being built</li>
        <li><strong class="pname"><code>cancels_cleanup</code></strong> - optional handle to a cleanup action, that is removed after the 
          call.  Typically this is used for 'N' parameters, which already 
          consume an object reference</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="get_parameters"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_parameters</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">force_tuple_creation</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.typehandlers.base-pysrc.html#BuildValueParameters.get_parameters">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_parameters-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for_get_parameters-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_parameters" name="call_graph_for_get_parameters">
<area shape="rect" href="pybindgen.converter_functions.CToPythonConverter-class.html#generate" title="converter_functions.CToPythonConverter.generate()" alt="" coords="35,5,539,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.BuildValueParameters-class.html#get_parameters" title="get_parameters()" alt="" coords="617,61,796,93"/>
<area shape="rect" href="pybindgen.cppmethod.CppVirtualMethodProxy-class.html#generate_python_call" title="cppmethod.CppVirtualMethodProxy.generate_python_call()" alt="" coords="7,61,567,93"/>
<area shape="rect" href="pybindgen.typehandlers.base.ForwardWrapperBase-class.html#generate_body" title="ForwardWrapperBase.generate_body()" alt="" coords="99,117,475,149"/>
</map>
  <img src="call_graph_for_get_parameters.gif" alt='' usemap="#call_graph_for_get_parameters" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>returns a list of parameters to pass into a Py_BuildValue-style 
  function call, the first paramter in the list being the template 
  string.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>force_tuple_creation</code></strong> - if True, Py_BuildValue is instructed to always create a tuple, 
          even for zero or 1 values.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:26 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
